<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: include/espressif/esp_spiffs.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_cf4dbf1328d2cf10d3f3933741525dc7.html">espressif</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">esp_spiffs.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * ESPRSSIF MIT License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2015 &lt;ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * it is free of charge, to any person obtaining a copy of this software and associated</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the Software is furnished</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * substantial portions of the Software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef __ESP_SPIFFS_H__</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define __ESP_SPIFFS_H__</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;spiffs/spiffs.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html">   45</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structesp__spiffs__config.html">esp_spiffs_config</a> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#a3730a1b272a6d5d2f567a2876f4cdc46">   46</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#a3730a1b272a6d5d2f567a2876f4cdc46">phys_size</a>;        </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#a7ba95ed315e15b8c4573ff01477b1ecf">   47</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#a7ba95ed315e15b8c4573ff01477b1ecf">phys_addr</a>;        </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#af4070ae5fe9914a88e6b5afa775c112a">   48</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#af4070ae5fe9914a88e6b5afa775c112a">phys_erase_block</a>; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#ac7518f38292532ca42fd8ed8a290259b">   50</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#ac7518f38292532ca42fd8ed8a290259b">log_block_size</a>;   </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#a0cfa1078dbb0a9591e9955d6dd0ad13a">   51</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#a0cfa1078dbb0a9591e9955d6dd0ad13a">log_page_size</a>;    </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#a0a344b6b0ea486bc2c857249dfd2e364">   53</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#a0a344b6b0ea486bc2c857249dfd2e364">fd_buf_size</a>;      </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structesp__spiffs__config.html#ad509b97f939dee79cf1cbdbddd780798">   54</a></span>&#160;    uint32 <a class="code" href="structesp__spiffs__config.html#ad509b97f939dee79cf1cbdbddd780798">cache_buf_size</a>;   </div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;};</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;sint32 <a class="code" href="group__Spiffs__APIs.html#ga72e4d349ef03c2671462a12976e4552f">esp_spiffs_init</a>(<span class="keyword">struct</span> <a class="code" href="structesp__spiffs__config.html">esp_spiffs_config</a> *config);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Spiffs__APIs.html#ga03894c9cf5d03c55d9f406ea5b58651d">esp_spiffs_deinit</a>(uint8 format);</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ESP_SPIFFS_H__ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="structesp__spiffs__config_html_a7ba95ed315e15b8c4573ff01477b1ecf"><div class="ttname"><a href="structesp__spiffs__config.html#a7ba95ed315e15b8c4573ff01477b1ecf">esp_spiffs_config::phys_addr</a></div><div class="ttdeci">uint32 phys_addr</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:47</div></div>
<div class="ttc" id="group__Spiffs__APIs_html_ga72e4d349ef03c2671462a12976e4552f"><div class="ttname"><a href="group__Spiffs__APIs.html#ga72e4d349ef03c2671462a12976e4552f">esp_spiffs_init</a></div><div class="ttdeci">sint32 esp_spiffs_init(struct esp_spiffs_config *config)</div><div class="ttdoc">Initialize spiffs. </div></div>
<div class="ttc" id="structesp__spiffs__config_html_ac7518f38292532ca42fd8ed8a290259b"><div class="ttname"><a href="structesp__spiffs__config.html#ac7518f38292532ca42fd8ed8a290259b">esp_spiffs_config::log_block_size</a></div><div class="ttdeci">uint32 log_block_size</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:50</div></div>
<div class="ttc" id="structesp__spiffs__config_html_af4070ae5fe9914a88e6b5afa775c112a"><div class="ttname"><a href="structesp__spiffs__config.html#af4070ae5fe9914a88e6b5afa775c112a">esp_spiffs_config::phys_erase_block</a></div><div class="ttdeci">uint32 phys_erase_block</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:48</div></div>
<div class="ttc" id="structesp__spiffs__config_html_a0a344b6b0ea486bc2c857249dfd2e364"><div class="ttname"><a href="structesp__spiffs__config.html#a0a344b6b0ea486bc2c857249dfd2e364">esp_spiffs_config::fd_buf_size</a></div><div class="ttdeci">uint32 fd_buf_size</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:53</div></div>
<div class="ttc" id="group__Spiffs__APIs_html_ga03894c9cf5d03c55d9f406ea5b58651d"><div class="ttname"><a href="group__Spiffs__APIs.html#ga03894c9cf5d03c55d9f406ea5b58651d">esp_spiffs_deinit</a></div><div class="ttdeci">void esp_spiffs_deinit(uint8 format)</div><div class="ttdoc">Deinitialize spiffs. </div></div>
<div class="ttc" id="structesp__spiffs__config_html_ad509b97f939dee79cf1cbdbddd780798"><div class="ttname"><a href="structesp__spiffs__config.html#ad509b97f939dee79cf1cbdbddd780798">esp_spiffs_config::cache_buf_size</a></div><div class="ttdeci">uint32 cache_buf_size</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:54</div></div>
<div class="ttc" id="structesp__spiffs__config_html_a0cfa1078dbb0a9591e9955d6dd0ad13a"><div class="ttname"><a href="structesp__spiffs__config.html#a0cfa1078dbb0a9591e9955d6dd0ad13a">esp_spiffs_config::log_page_size</a></div><div class="ttdeci">uint32 log_page_size</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:51</div></div>
<div class="ttc" id="structesp__spiffs__config_html_a3730a1b272a6d5d2f567a2876f4cdc46"><div class="ttname"><a href="structesp__spiffs__config.html#a3730a1b272a6d5d2f567a2876f4cdc46">esp_spiffs_config::phys_size</a></div><div class="ttdeci">uint32 phys_size</div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:46</div></div>
<div class="ttc" id="structesp__spiffs__config_html"><div class="ttname"><a href="structesp__spiffs__config.html">esp_spiffs_config</a></div><div class="ttdef"><b>Definition:</b> esp_spiffs.h:45</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
